Entity Collectable
Collectable is the parent class of all Entity types which can be carried in an inventory.
Subclass of Entity.
Functions
| GetRequiredAttribute (attrib) | GetRequiredAttribute returns the minimum reqiurement for a given attribute in order to use this item. |
| GetEffectAttribute (attrib) | GetEffectAttribute returns the bonus this item grants to the the given attribute. |
| GetWeightPerUnit () | GetWeightPerUnit returns the weight of a single unit of this entity. |
| GetWeightTotal () | GetWeightTotal returns the weight of all units of this entity. |
| GetValuePerUnit () | GetValuePerUnit returns the monetary value of a single unit of this entity. |
| GetValueTotal () | GetValueTotal returns the monetary value of all units of this entity. |
| GetCount () | GetCount returns the number of lootable/usable items of this entity that are being carried. |
| GetCountNonLootable () | GetCountNonLootable returns the number of non-lootable items of this entity that are being carried. |
| GetCountTotal () | GetCountTotal returns the total number of items of this entity that are being carried. |
| IsUnique () | IsUnique returns true if the item is listed as unique in the game. |
| CanBeRemoved () | CanBeRemoved returns true if the item can be removed from its equipped slot. |
| Lootable () | Lootable returns true if the item can be looted from the Actor carrying it. |
| BeenApplied () | BeenApplied returns true if the item's effects have been applied to the Actor equipping it. |
Functions
- GetRequiredAttribute (attrib)
-
GetRequiredAttribute returns the minimum reqiurement for a given attribute in order to use this item.
Parameters:
- attrib The name of the attribute, as shown in the Fallout: Tactics entity editor.
Returns:
-
The minimum required value of the requested attribute for this object.
- GetEffectAttribute (attrib)
-
GetEffectAttribute returns the bonus this item grants to the the given attribute.
Parameters:
- attrib The name of the attribute, as shown in the Fallout: Tactics entity editor.
Returns:
-
The bonus value this item grants for that attribute.
- GetWeightPerUnit ()
-
GetWeightPerUnit returns the weight of a single unit of this entity.
Returns:
-
The weight of one unit of this entity, as a numeric value.
- GetWeightTotal ()
-
GetWeightTotal returns the weight of all units of this entity.
Returns:
-
The weight of all units of this entity, as a numeric value.
- GetValuePerUnit ()
-
GetValuePerUnit returns the monetary value of a single unit of this entity.
Returns:
-
The monetaryvalue of one unit of this entity, as a numeric value.
- GetValueTotal ()
-
GetValueTotal returns the monetary value of all units of this entity.
Returns:
-
The monetary value of all units of this entity, as a numeric value.
- GetCount ()
-
GetCount returns the number of lootable/usable items of this entity that are being carried.
Returns:
-
The number of lootable items.
- GetCountNonLootable ()
-
GetCountNonLootable returns the number of non-lootable items of this entity that are being carried.
Returns:
-
The number of non-lootable items.
- GetCountTotal ()
-
GetCountTotal returns the total number of items of this entity that are being carried.
Returns:
-
The total number of items.
- IsUnique ()
-
IsUnique returns true if the item is listed as unique in the game.
Returns:
-
A boolean indicating if the item is unique.
- CanBeRemoved ()
-
CanBeRemoved returns true if the item can be removed from its equipped slot.
Returns:
-
A boolean indicating if the item can be removed.
- Lootable ()
-
Lootable returns true if the item can be looted from the Actor carrying it.
Returns:
-
A boolean indicating if the item is lootable.
- BeenApplied ()
-
BeenApplied returns true if the item's effects have been applied to the Actor equipping it.
Returns:
-
A boolean indicating if the item effects have been applied.